<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GLoadableIcon</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIO Reference Manual">
<link rel="up" href="icons.html" title="Icons">
<link rel="prev" href="GFileIcon.html" title="GFileIcon">
<link rel="next" href="GThemedIcon.html" title="GThemedIcon">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
<link rel="chapter" href="ch01.html" title="Introduction">
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
<link rel="chapter" href="ch03.html" title="Running GIO applications">
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
<link rel="chapter" href="file_ops.html" title="File Operations">
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
<link rel="chapter" href="async.html" title="Asynchronous I/O">
<link rel="chapter" href="streaming.html" title="Streaming I/O">
<link rel="chapter" href="types.html" title="File types and applications">
<link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
<link rel="chapter" href="icons.html" title="Icons">
<link rel="chapter" href="utils.html" title="Utilities">
<link rel="chapter" href="extending.html" title="Extending GIO">
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GFileIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="icons.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIO Reference Manual</th>
<td><a accesskey="n" href="GThemedIcon.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2788138" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2876794" class="shortcut">Description</a>
                  &#160;|&#160;
                  <a href="#id2886540" class="shortcut">Object Hierarchy</a>
                  &#160;|&#160;
                  <a href="#id2886564" class="shortcut">Prerequisites</a>
                  &#160;|&#160;
                  <a href="#id2876773" class="shortcut">Known Implementations</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GLoadableIcon"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2788138"></a><span class="refentrytitle">GLoadableIcon</span>
</h2>
<p>GLoadableIcon &#8212; Loadable Icons</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gio/gio.h&gt;


                    <a class="link" href="GLoadableIcon.html#GLoadableIcon-struct">GLoadableIcon</a>;
                    <a class="link" href="GLoadableIcon.html#GLoadableIconIface">GLoadableIconIface</a>;
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GLoadableIcon.html#g-loadable-icon-load">g_loadable_icon_load</a>                (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         int size,
                                                         char **type,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
void                <a class="link" href="GLoadableIcon.html#g-loadable-icon-load-async">g_loadable_icon_load_async</a>          (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         int size,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       <a class="link" href="GLoadableIcon.html#g-loadable-icon-load-finish">g_loadable_icon_load_finish</a>         (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res,
                                                         char **type,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);


</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2886540"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">

  GInterface
   +----GLoadableIcon
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2886564"></a><h2>Prerequisites</h2>
<p>
GLoadableIcon requires
 <a class="link" href="GIcon.html" title="GIcon">GIcon</a> and  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876773"></a><h2>Known Implementations</h2>
<p>
GLoadableIcon is implemented by
 <a class="link" href="GFileIcon.html" title="GFileIcon">GFileIcon</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876794"></a><h2>Description</h2>
<p>
Extends the <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> interface and adds the ability to 
load icons from streams.</p>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2876821"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2876832"></a><h3>
<a name="GLoadableIcon-struct"></a>GLoadableIcon</h3>
<a class="indexterm" name="id2876844"></a><pre class="programlisting">typedef struct _GLoadableIcon GLoadableIcon;</pre>
<p>
Generic type for all kinds of icons that can be loaded 
as a stream.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2876865"></a><h3>
<a name="GLoadableIconIface"></a>GLoadableIconIface</h3>
<a class="indexterm" name="id2876877"></a><pre class="programlisting">typedef struct {
  GTypeInterface g_iface;

  /* Virtual Table */

  GInputStream * (*load)        (GLoadableIcon      *icon,
				 int                 size,
				 char              **type,
				 GCancellable       *cancellable,
				 GError            **error);
  void           (*load_async)  (GLoadableIcon      *icon,
				 int                 size,
				 GCancellable       *cancellable,
				 GAsyncReadyCallback callback,
				 gpointer            user_data);
  GInputStream * (*load_finish) (GLoadableIcon      *icon,
				  GAsyncResult      *res,
				  char             **type,
				  GError           **error);
} GLoadableIconIface;
</pre>
<p>
Interface for icons that can be loaded as a stream.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"
>GTypeInterface</a>&#160;<em class="structfield"><code>g_iface</code></em>;</span></p></td>
<td> The parent interface.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>load</code></em>&#160;()</span></p></td>
<td> Loads an icon.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>load_async</code></em>&#160;()</span></p></td>
<td> Loads an icon asynchronously.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>load_finish</code></em>&#160;()</span></p></td>
<td> Finishes an asynchronous icon load.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2876977"></a><h3>
<a name="g-loadable-icon-load"></a>g_loadable_icon_load ()</h3>
<a class="indexterm" name="id2876988"></a><pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_loadable_icon_load                (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         int size,
                                                         char **type,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Loads a loadable icon. For the asynchronous version of this function, 
see <a class="link" href="GLoadableIcon.html#g-loadable-icon-load-async"><code class="function">g_loadable_icon_load_async()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></p></td>
<td> an integer.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td>  a location to store the type of the loaded icon, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore. 
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to 
ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> to read the icon from.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2877202"></a><h3>
<a name="g-loadable-icon-load-async"></a>g_loadable_icon_load_async ()</h3>
<a class="indexterm" name="id2877213"></a><pre class="programlisting">void                g_loadable_icon_load_async          (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         int size,
                                                         <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
                                                         <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Loads an icon asynchronously. To finish this function, see 
<a class="link" href="GLoadableIcon.html#g-loadable-icon-load-finish"><code class="function">g_loadable_icon_load_finish()</code></a>. For the synchronous, blocking 
version of this function, see <a class="link" href="GLoadableIcon.html#g-loadable-icon-load"><code class="function">g_loadable_icon_load()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></p></td>
<td> an integer.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore. 
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td> the data to pass to callback function
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2896529"></a><h3>
<a name="g-loadable-icon-load-finish"></a>g_loadable_icon_load_finish ()</h3>
<a class="indexterm" name="id2896541"></a><pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>*       g_loadable_icon_load_finish         (<a class="link" href="GLoadableIcon.html" title="GLoadableIcon">GLoadableIcon</a> *icon,
                                                         <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res,
                                                         char **type,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Finishes an asynchronous icon load started in <a class="link" href="GLoadableIcon.html#g-loadable-icon-load-async"><code class="function">g_loadable_icon_load_async()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>res</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td> a location to store the type of the loaded icon, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> location to store the error occuring, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to 
ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> to read the icon from.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2896724"></a><h2>See Also</h2>
<a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a>
</div>
<div class="refsect1" lang="en">
<a name="id2896746"></a><div class="refsect2" lang="en"><a name="id2896747"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2896748"></a></div>
</div>
</div>
</body>
</html>
